feat(minidump): Add `sentry-minidump` integration by timfish · Pull Request #1315 · getsentry/sentry-rust

timfish · 2026-09-11T12:50:00Z

Adds a new sentry-minidump crate that captures native crashes as minidumps in a separate process and sends them to Sentry as attachments. Enable it with the minidump feature on sentry. Linux, macOS and Windows only.

The code is ported from the standalone sentry-rust-minidump crate.

How it works

The integration re-executes the current binary as a crash reporter process. The app process spawns the reporter and connects to it; the reporter attaches a native crash handler and waits. On a crash it writes a minidump, attaches it to a Fatal event, and uploads it. Scope does not cross the process boundary on its own. To give the crash event context (user, tags, extra, breadcrumbs), the app sends updates to the reporter explicitly through methods on the integration; each call is forwarded over a socket and applied to the reporter's scope.

Difference from `sentry-rust-minidump`

In sentry-rust-minidump the process model is explicit: you call init(&client), which re-executes the binary, and you then have to pass the client in by hand, keep the returned Handle alive for the life of the program (or leak() it), and know that everything before init runs in both processes.

Here the process work moves inside Integration::setup, which runs inside Client::with_options before sentry::init binds the client to the hub. That removes most of the ceremony:

In the app process, setup spawns the reporter and keeps the handle inside the integration, which the client owns for the life of the process. No Handle, no leak(), no client to pass in.
In the reporter process, setup never returns. It builds its own client from the cloned ClientOptions, runs the minidump server loop, and exits. sentry::init is the last line of main that runs there.

Scope sync is still manual, reached via sentry::with_integration instead of a method on a Handle. inherit_args now defaults to true since I suspect this will be more useful to most without causing pain for others.

The one caveat is inherent to re-executing the binary: code before sentry::init still runs in both processes. is_crash_reporter_process() stays public so apps can gate on that.

Resolves #1316

cursor

Stale Bugbot comment from a previous run.

szokeasaurusrex

For the most part, this looks good, but I left a couple suggestions I think we should implement before merging.

I tested it out locally and the crashes are showing up nicely in the UI.

szokeasaurusrex · 2026-09-14T13:55:10Z

h: We generate these README.md files with cargo readme in the version-bumping script, using this command:

sentry-rust/scripts/generate-readme.sh

Line 8 in 2f5d794

cargo readme --template ../README.tpl --output README.md

The files are generated from the crate-level documentation in src/lib.rs. It seems that this README contains some information not included in src/lib.rs, so you should move that information into src/lib.rs so that the README survives regeneration.

codecov · 2026-09-14T14:57:53Z

Codecov Report

❌ Patch coverage is 0% with 222 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.14%. Comparing base (a57b91c) to head (4973465).
⚠️ Report is 181 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1315      +/-   ##
==========================================
+ Coverage   73.81%   74.14%   +0.32%     
==========================================
  Files          64       79      +15     
  Lines        7538     9950    +2412     
==========================================
+ Hits         5564     7377    +1813     
- Misses       1974     2573     +599

…h/sentry-rust into feat/minidump-integration

timfish · 2026-09-14T18:52:56Z

@szokeasaurusrex do you think we should set the default process name as sentry crash reporter, crash reporter or similar?

szokeasaurusrex · 2026-09-14T19:38:25Z

@szokeasaurusrex do you think we should set the default process name as sentry crash reporter, crash reporter or similar?

Yes, I think that's a good idea, but I'd also include some indication that the process is part of the Rust SDK.

I think something like "Sentry Rust SDK Crash Reporter" or "Crash Reporter (Sentry Rust SDK)" could work well.

szokeasaurusrex

Looks like you addressed my previous feedback 🙏

I identified a couple more small items but lgtm in general; please ping me when this is ready to be merged

szokeasaurusrex · 2026-09-15T15:43:03Z

@timfish if I understand correctly, after this change is released, the existing sentry-rust-minidump crate will continue to exist separately, and this will be released as a new sentry-minidump crate?

The one thing I am not sure about is whether Craft will be able to create a new crate when releasing, or if it will error because the crate does not exist yet. I haven't released a new crate at Sentry before so this may be worth looking into

timfish · 2026-09-16T01:03:29Z

the existing sentry-rust-minidump crate will continue to exist separately, and this will be released as a new sentry-minidump crate?

At some point I will publish a release of sentry-rust-minidump with deprecation and readme notices pointing to the new officially supported integration.

sentry-minidump using the integration API makes sentry-rust-minidump redundant!

Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>

Make some improvements to the `sentry-minidump` e2e test that will make the test more reliable and faster: - Allow the OS to assign an available port for the test rather than hardcoding port `8123` (or another fixed port), which causes the test to fail when that port is occupied - Add a timeout for the child process to ensure the test does not get stuck waiting forever if the child process does not exit - Lower existing timeouts and delays to make the test run faster

sentry · 2026-09-17T11:48:46Z

+                return;
+            }
+            match self.build_child().spawn() {
+                Ok(handle) => {
+                    let _ = self.handle.set(handle);
+                }
+                Err(err) => {
+                    sentry_debug!("could not start crash reporter: {err}");
+                }
+            }
+        });


Bug: A panic within the setup function's call_once block can poison a static Once guard, causing subsequent sentry::init calls to panic immediately.
_{Severity: LOW}

Suggested Fix

To prevent the Once from being poisoned, wrap the code inside the call_once closure with std::panic::catch_unwind. This will catch any panics, allowing the program to handle the error gracefully without poisoning the static Once guard and preventing subsequent initializations from crashing.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: sentry-minidump/src/lib.rs#L456-L477 Potential issue: The `setup` function uses a static `std::sync::Once` to ensure its initialization logic runs only once. If a panic occurs within the closure passed to `SETUP.call_once`, for instance, if an integration's `setup()` method panics during the creation of the crash reporter client, the `Once` object becomes poisoned. Any subsequent attempt to initialize the client by calling `sentry::init` will trigger `setup` again. The subsequent call to `SETUP.call_once` will then immediately panic because the `Once` is poisoned, leading to a crash. While this requires a second `sentry::init` call after a panic, it represents a potential unhandled crash condition.

I think this is ok, because we would have already panicked, and multiple initializations are rare

feat(minidump): Add sentry-minidump integration

cf9094b

timfish requested a review from a team as a code owner September 11, 2026 12:50

This comment was marked as resolved.

Sign in to view

sentry Bot reviewed Sep 11, 2026

View reviewed changes

Comment thread sentry-minidump/src/lib.rs Outdated

cursor Bot reviewed Sep 11, 2026

View reviewed changes

Comment thread sentry-minidump/src/lib.rs Outdated

timfish added 3 commits September 11, 2026 15:04

docs(minidump): Link PR in changelog entry

220a953

fix(minidump): Downcast through the Integration vtable when filtering

2f5d794

Merge branch 'master' into feat/minidump-integration

97d3034

szokeasaurusrex reviewed Sep 14, 2026

View reviewed changes

timfish added 2 commits September 14, 2026 18:15

PR review changes

d59631b

Merge branch 'feat/minidump-integration' of https://github.com/timfis…

526bbd3

…h/sentry-rust into feat/minidump-integration

Set default reporter process name

a31aca1

szokeasaurusrex mentioned this pull request Sep 15, 2026

ref(lints): Enforce missing_docs lint globally #1321

Merged

szokeasaurusrex approved these changes Sep 15, 2026

View reviewed changes

Comment thread sentry-minidump/examples/app.rs

Comment thread sentry-minidump/src/lib.rs Outdated

Comment thread sentry-minidump/src/lib.rs Outdated

Comment thread sentry-minidump/src/lib.rs Outdated

timfish and others added 2 commits September 16, 2026 02:05

PR review

fa20240

Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>

Merge branch 'master' into feat/minidump-integration

2048df9

szokeasaurusrex enabled auto-merge (squash) September 16, 2026 12:02

sentry Bot reviewed Sep 16, 2026

View reviewed changes

Comment thread sentry-minidump/src/lib.rs Outdated

run cargo fmt

dbdf792

szokeasaurusrex disabled auto-merge September 16, 2026 12:19

szokeasaurusrex reviewed Sep 16, 2026

View reviewed changes

Comment thread sentry-minidump/tests/e2e.rs Outdated

add back accidentally deleted lines

406dbdc

sentry Bot reviewed Sep 16, 2026

View reviewed changes

Comment thread sentry-minidump/src/lib.rs Outdated

This comment was marked as resolved.

Sign in to view

szokeasaurusrex and others added 4 commits September 16, 2026 16:52

test: increase cargo run timeout

59074ff

PR review

6024b7f

Don't spawn child if there isn't a DSN

e6a4f29

ensure one init per process

4973465

sentry Bot reviewed Sep 17, 2026

View reviewed changes

szokeasaurusrex merged commit cbed0fa into getsentry:master Sep 17, 2026
28 checks passed

timfish deleted the feat/minidump-integration branch September 17, 2026 12:47

sentry-release-bot Bot mentioned this pull request Sep 21, 2026

publish: getsentry/sentry-rust@0.49.3 getsentry/publish#9592

Closed

3 tasks

Uh oh!

Conversation

timfish commented Sep 11, 2026 • edited by szokeasaurusrex Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How it works

Difference from sentry-rust-minidump

Uh oh!

This comment was marked as resolved.

Uh oh!

cursor Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

szokeasaurusrex Sep 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov Bot commented Sep 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

timfish commented Sep 14, 2026

Uh oh!

szokeasaurusrex commented Sep 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

szokeasaurusrex commented Sep 15, 2026

Uh oh!

timfish commented Sep 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

sentry Bot Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

timfish commented Sep 11, 2026 •

edited by szokeasaurusrex

Loading

Difference from `sentry-rust-minidump`

cursor Bot left a comment •

edited

Loading

codecov Bot commented Sep 14, 2026 •

edited

Loading

szokeasaurusrex commented Sep 14, 2026 •

edited

Loading